home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Vk / VkResizer.z / VkResizer
Encoding:
Text File  |  2002-10-03  |  8.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr((((3333xxxx))))                                                    VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkResizer - Attachment class for resizing and moving widgets
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkResizer.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkResizer(Boolean autoAdjust = False,
  20.                      Boolean liveResize = False);
  21.            virtual ~VkResizer(void);
  22.  
  23.  
  24.    CCCCoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn
  25.            void setIncrements(int resizeWidth,
  26.                               int resizeHeight,
  27.                               int moveX, int moveY);
  28.            void attach(Widget w);
  29.            void detach(void);
  30.            void adjustGeometry(void);
  31.  
  32.  
  33.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  34.            Boolean shown(void);
  35.  
  36.  
  37.  
  38.  
  39. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  40.      The VkResizer class is an attachment rather than a component.  You use
  41.      the attach method to attach it to an existing widget, and then call the
  42.      show method to make it visible.  Once visible, VkResizer will
  43.      automatically allow the user to resize and move the widget using
  44.      VkResizer's controls.  VkResizer is useful to the developer who wants to
  45.      give the user geometry control over widgets using a consistent
  46.      presentation.
  47.  
  48.  
  49. DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
  50.      It is not expected that developers would subclass VkResizer.
  51.  
  52.  
  53. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  54.    VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr(((())))
  55.            VkResizer(Boolean autoAdjust = False,
  56.                      Boolean liveResize = False);
  57.            virtual void ~VkResizer(void);
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr((((3333xxxx))))                                                    VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           The VkResizer constructor creates an object capable of attaching to
  75.           a widget and displaying geometry controls for the user.  The first
  76.           parameter controls whether VkResizer tracks outside geometry changes
  77.           to its attached widget, for adjustment of its geometry controls.
  78.           The second parameter controls whether the widget itself or a
  79.           rectangle representing the widget area is displayed during geometry
  80.           changes.  Setting the second parameter to True causes intermediate
  81.           geometry changes in the attached widget, which may affect
  82.           performance.
  83.  
  84.    sssseeeettttIIIInnnnccccrrrreeeemmmmeeeennnnttttssss(((())))
  85.            void setIncrements(int resizeWidth,
  86.                               int resizeHeight,
  87.                               int moveX, int moveY);
  88.  
  89.  
  90.           VkResizer's geometry manipulations are configurable.  The first two
  91.           parameters specify the resize increments in the horizontal and
  92.           vertical dimension, respectively.  The last two parameters specify
  93.           the move increments in the horizontal and vertical dimension,
  94.           respectively.  Setting an increment to zero prohibits resizing or
  95.           moving in that dimension.
  96.  
  97.    sssshhhhoooowwwwnnnn(((())))
  98.           Boolean shown(void);
  99.  
  100.  
  101.           This function indicates whether VkResizer is visible and displaying
  102.           its geometry controls.
  103.  
  104.    aaaattttttttaaaacccchhhh(((())))
  105.           void attach(Widget w);
  106.  
  107.  
  108.           This function is used to attach VkResizer to an existing widget.  If
  109.           VkResizer is already attached to a widget, if first detaches.
  110.           Attaching to a widget sets up VkResizer for geometry control of that
  111.           widget.  If VkResizer is shown, it displays its geometry controls
  112.           around the attached widget.
  113.  
  114.    ddddeeeettttaaaacccchhhh(((())))
  115.           void detach(void);
  116.  
  117.  
  118.           This function detaches VkResizer from its attached widget.  Its
  119.           geometry controls are removed.
  120.  
  121.    aaaaddddjjjjuuuussssttttGGGGeeeeoooommmmeeeettttrrrryyyy(((())))
  122.           void adjustGeometry(void);
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr((((3333xxxx))))                                                    VVVVkkkkRRRReeeessssiiiizzzzeeeerrrr((((3333xxxx))))
  137.  
  138.  
  139.  
  140.           This function forces VkResizer to adjust its geometry controls to
  141.           the geometry of its attached widget.  Use this function when auto-
  142.           adjustment was not selected in the VkResizer constructor, and the
  143.           attached widget has changed geometry.
  144.  
  145.    ssssttttaaaatttteeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  146.           static const const char* stateChangedCallback;
  147.  
  148.  
  149.           This callback informs the application when VkResizer has modified
  150.           the geometry of its attached widget.  The reason for the callback
  151.           can be VR_resizing, VR_moving, VR_resized, or VR_moved.  VR_resizing
  152.           and VR_moving indicate that resizing or moving are in progress, and
  153.           are sent repeatedly as the user adjusts the geometry.  VR_resized
  154.           and VR_moved indicate that the resizing or moving is complete, and
  155.           are sent when the user releases the VkResizer geometry controls.
  156.  
  157. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  158.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  159.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  160.           setDefaultResources(), getResources(), manage(), unmanage(),
  161.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  162.  
  163.  
  164.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  165.           callCallbacks(), addCallback(), removeCallback(),
  166.           removeAllCallbacks(),
  167.  
  168.  
  169. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  170.      VkApp
  171.  
  172. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  173.      VkComponent, VkApp
  174.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  175.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  176.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  177.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.